/**
 * Copyright 2010 Terrestrial Ecosystem Research Network, licensed under the Apache
 * License, Version 2.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or
 * agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and
 * limitations under the License.
 */

package au.org.tern.ecoinformatics.oai.provider.sample.model;

import java.util.ArrayList;
import java.util.List;

/**
 * Basic model for Species data. different jurisdictions and agencies will have their own models (unfortunately!).  
 * 
 * @author vhobbs
 *
 */
public class SampleSpecies {

	private String CommonName;
	private String ScientificName;
	private List<RankValue> taxonPath = new ArrayList<RankValue>();
	
	
	public String getCommonName() {
		return CommonName;
	}

	public void setCommonName(String commonName) {
		CommonName = commonName;
	}

	public String getScientificName() {
		return ScientificName;
	}

	public void setScientificName(String scientificName) {
		ScientificName = scientificName;
	}

	public void addRankValue(RankValue rankValue) {
		taxonPath.add(rankValue);
	}
	
	public List<RankValue> getTaxonPath() {
		return taxonPath;
	}


	public enum Rank {
		KINGDOM, 
		DIVISION,
		CLASS, 
		ORDER,
		FAMILY, 
		GENUS,
		SPECIES;
		
	}
	
	
	public class RankValue {
		
		private Rank rank;
		private String value;
		
		public Rank getRank() {
			return rank;
		}
		public void setRank(Rank rank) {
			this.rank = rank;
		}
		public String getValue() {
			return value;
		}
		public void setValue(String value) {
			this.value = value;
		}
	}
}
